Mouse

  1. Home
  2. Documentation
  3. Scripting
  4. Mouse

Singleton class that implements IMouse

Properties

Mode

CursorMode Mode

Gets/sets the current mouse cursor mode.

Visible

bool Visible

Gets/sets whether the mouse cursor is visible.

x

int x

Gets current mouse X position.

y

int y

Gets current mouse Y position.

Methods

ChangeModeGraphic

void ChangeModeGraphic(CursorMode cursorMode, int slot)

Changes the sprite for the specified mouse cursor.

ChangeModeHotspot

Changes the active hotspot for the specified mouse cursor.

ChangeModeView

Changes the view used to animate the specified mouse cursor.

DisableMode

void DisableMode(CursorMode cursorMode)  
void DisableMode(int cursorMode)

Disables the specified cursor mode.

EnableMode

void EnableMode(CursorMode cursorMode)

Re-enables the specified cursor mode.

GetModeGraphic

Gets the sprite used for the specified mouse cursor.

IsButtonDown

LooseInteger IsButtonDown(MouseButton mouseButton)

Checks whether the specified mouse button is currently pressed.

SaveCursorUntilItLeaves

Remembers the current mouse cursor and restores it when the mouse leaves the current area.

SelectNextMode

void SelectNextMode()

Cycles to the next available mouse cursor.

SelectPreviousMode

Selects the previous enabled mouse cursor mode.

SetBounds

Restricts the mouse movement to the specified area.

SetPosition

void SetPosition(int x, int y)

Moves the mouse cursor to the specified location.

Update

void Update()

Updates the X and Y co-ordinates to match the current mouse position.

UseDefaultGraphic

void UseDefaultGraphic()

Changes the current mouse cursor back to the default for the current mode.

UseModeGraphic

void UseModeGraphic(CursorMode cursorMode)

Changes the mouse cursor to use the graphic for a different non-active cursor mode.